/*
 * Copyright 2012 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.guvnor.common.services.shared.metadata;

import java.util.List;
import java.util.Map;

import org.guvnor.common.services.shared.metadata.model.Metadata;
import org.jboss.errai.bus.server.annotations.Remote;
import org.uberfire.backend.vfs.Path;

/**
 *
 */
@Remote
public interface MetadataService {

    Metadata getMetadata(final Path resource);

    List<String> getTags(final Path resource);

    Map<String, Object> configAttrs(final Map<String, Object> attrs,
                                    final Metadata metadata);

    Map<String, Object> setUpAttributes(final Path path,
                                        final Metadata metadata);

    /**
     * Only saves the Metadata for an asset.
     * @param path Path to the file that the metadata belongs to
     * @param metadata Actual metadata to be saved.
     * @param comment Commit comment.
     * @return
     */
    Path saveMetadata(final Path path,
                      final Metadata metadata,
                      final String comment);
}
